<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>profilehooks</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;profilehooks
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="profilehooks-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="profilehooks-module.html">Module profilehooks</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-docstring">Profiling hooks</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-docstring">This module contains a couple of decorators (`profile` and `coverage`) that</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-docstring">can be used to wrap functions and/or methods to produce profiles and line</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-docstring">coverage reports.</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring">Usage example (Python 2.4 or newer):</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring">    from profilehooks import profile, coverage</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">    @profile    # or @coverage</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">    def fn(n):</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">        if n &lt; 2: return 1</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring">        else: return n * fn(n-1)</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">    print fn(42)</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">Usage example (Python 2.3 or older):</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">    from profilehooks import profile, coverage</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">    def fn(n):</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">        if n &lt; 2: return 1</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">        else: return n * fn(n-1)</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">    # Now wrap that function in a decorator</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">    fn = profile(fn) # or coverage(fn)</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">    print fn(42)</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">Reports for all thusly decorated functions will be printed to sys.stdout</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">on program termination.  You can alternatively request for immediate</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">reports for each call by passing immediate=True to the profile decorator.</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">There's also a @timecall decorator for printing the time to sys.stderr</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">every time a function is called, when you just want to get a rough measure</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">instead of a detailed (but costly) profile.</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">Caveats</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">  A thread on python-dev convinced me that hotshot produces bogus numbers.</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">  See http://mail.python.org/pipermail/python-dev/2005-November/058264.html</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">  I don't know what will happen if a decorated function will try to call</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">  another decorated function.  All decorators probably need to explicitly</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">  support nested profiling (currently TraceFuncCoverage is the only one that</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">  supports this, while HotShotFuncProfile has support for recursive functions.)</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">  Profiling with hotshot creates temporary files (*.prof and *.prof.pickle for</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">  profiling, *.cprof for coverage) in the current directory.  These files are</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">  not cleaned up.  (In fact, the *.pickle versions are intentionally written</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">  out in case you want to look at the profiler results without having to parse</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">  the big *.prof file with hotshot.stats.load, which takes ages.  Just unpickle</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">  the file and you'll get a pstats object.)</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">  Coverage analysis with hotshot seems to miss some executions resulting in</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">  lower line counts and some lines errorneously marked as never executed.  For</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">  this reason coverage analysis now uses trace.py which is slower, but more</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">  accurate.</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">  Decorating functions causes doctest.testmod() to ignore doctests in those</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">  functions.</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">Copyright (c) 2004--2006 Marius Gedminas &lt;marius@pov.lt&gt;</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">Released under the MIT licence since December 2006:</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">    Permission is hereby granted, free of charge, to any person obtaining a</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">    copy of this software and associated documentation files (the "Software"),</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">    to deal in the Software without restriction, including without limitation</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">    the rights to use, copy, modify, merge, publish, distribute, sublicense,</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">    and/or sell copies of the Software, and to permit persons to whom the</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">    Software is furnished to do so, subject to the following conditions:</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">    The above copyright notice and this permission notice shall be included in</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">    all copies or substantial portions of the Software.</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">    DEALINGS IN THE SOFTWARE.</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring">(Previously it was distributed under the GNU General Public Licence.)</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-comment"># $Id: profilehooks.py 54 2006-12-05 23:10:37Z mg $</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">"Marius Gedminas (marius@gedmin.as)"</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"><tt class="py-name">__copyright__</tt> <tt class="py-op">=</tt> <tt class="py-string">"Copyright 2004-2006, Marius Gedminas"</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-name">__license__</tt> <tt class="py-op">=</tt> <tt class="py-string">"MIT"</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-string">"1.0"</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-name">__date__</tt> <tt class="py-op">=</tt> <tt class="py-string">"2006-12-06"</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Method profilehooks.FuncProfile.atexit()=profilehooks.FuncProfile-class.html#atexit,Method profilehooks.HotShotFuncCoverage.atexit()=profilehooks.HotShotFuncCoverage-class.html#atexit,Method profilehooks.HotShotFuncProfile.atexit()=profilehooks.HotShotFuncProfile-class.html#atexit,Method profilehooks.TraceFuncCoverage.atexit()=profilehooks.TraceFuncCoverage-class.html#atexit"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-0', 'atexit', 'link-0');">atexit</a></tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">inspect</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">sys</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">cPickle</tt> <tt class="py-keyword">as</tt> <tt class="py-name">pickle</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-comment"># For profiling</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Function profilehooks.profile()=profilehooks-module.html#profile"><a title="profilehooks.profile" class="py-name" href="#" onclick="return doclink('link-1', 'profile', 'link-1');">profile</a></tt> <tt class="py-keyword">import</tt> <tt class="py-name">Profile</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">pstats</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-comment"># For hotshot profiling (inaccurate!)</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">hotshot</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-comment"># For trace.py coverage</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">trace</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-comment"># For hotshot coverage (inaccurate!; uses undocumented APIs; might break)</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt class="py-name">_hotshot</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">log</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-comment"># For timecall</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">import</tt> <tt id="link-2" class="py-name" targets="Variable spaceship.Projectile.time=spaceship.Projectile-class.html#time"><a title="spaceship.Projectile.time" class="py-name" href="#" onclick="return doclink('link-2', 'time', 'link-2');">time</a></tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"> </tt>
<a name="profile"></a><div id="profile-def"><a name="L123"></a><tt class="py-lineno">123</tt> <a class="py-toggle" href="#" id="profile-toggle" onclick="return toggle('profile');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks-module.html#profile">profile</a><tt class="py-op">(</tt><tt class="py-param">fn</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">skip</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">immediate</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="profile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="profile-expanded"><a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">    <tt class="py-docstring">"""Mark `fn` for profiling.</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">    If `immediate` is False, profiling results will be printed to sys.stdout on</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-docstring">    program termination.  Otherwise results will be printed after each call.</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">    If `skip` is &gt; 0, first `skip` calls to `fn` will not be profiled.</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">    If `filename` is specified, the profile stats will be pickled and stored in</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-docstring">    a file.</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"><tt class="py-docstring">    Usage:</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-docstring">        def fn(...):</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">            ...</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">        fn = profile(fn, skip=1)</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring">    If you are using Python 2.4, you should be able to use the decorator</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">    syntax:</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">        @profile(skip=3)</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">        def fn(...):</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">            ...</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">    or just</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-docstring">        @profile</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-docstring">        def fn(...):</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt class="py-docstring">            ...</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">fn</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> <tt class="py-comment"># @profile() syntax -- we are a decorator maker</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">        <tt class="py-keyword">def</tt> <tt class="py-def-name">decorator</tt><tt class="py-op">(</tt><tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt id="link-3" class="py-name"><a title="profilehooks.profile" class="py-name" href="#" onclick="return doclink('link-3', 'profile', 'link-1');">profile</a></tt><tt class="py-op">(</tt><tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-name">skip</tt><tt class="py-op">=</tt><tt class="py-name">skip</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">=</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">                           <tt class="py-name">immediate</tt><tt class="py-op">=</tt><tt class="py-name">immediate</tt><tt class="py-op">)</tt> </tt>
</div><a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">decorator</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">    <tt class="py-comment"># @profile syntax -- we are a decorator.</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt id="link-4" class="py-name" targets="Class profilehooks.FuncProfile=profilehooks.FuncProfile-class.html"><a title="profilehooks.FuncProfile" class="py-name" href="#" onclick="return doclink('link-4', 'FuncProfile', 'link-4');">FuncProfile</a></tt><tt class="py-op">(</tt><tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-name">skip</tt><tt class="py-op">=</tt><tt class="py-name">skip</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">=</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">immediate</tt><tt class="py-op">=</tt><tt class="py-name">immediate</tt><tt class="py-op">)</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">         <tt class="py-comment"># or HotShotFuncProfile</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment"># We cannot return fp or fp.__call__ directly as that would break method</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment"># definitions, instead we need to return a plain function.</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-keyword">def</tt> <tt class="py-def-name">new_fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">fp</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
</div><a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">    <tt class="py-name">new_fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">new_fn</tt> </tt>
</div><a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line"> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line"> </tt>
<a name="coverage"></a><div id="coverage-def"><a name="L170"></a><tt class="py-lineno">170</tt> <a class="py-toggle" href="#" id="coverage-toggle" onclick="return toggle('coverage');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks-module.html#coverage">coverage</a><tt class="py-op">(</tt><tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="coverage-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="coverage-expanded"><a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line">    <tt class="py-docstring">"""Mark `fn` for line coverage analysis.</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"><tt class="py-docstring">    Results will be printed to sys.stdout on program termination.</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-docstring">    Usage:</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"><tt class="py-docstring">        def fn(...):</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"><tt class="py-docstring">            ...</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-docstring">        fn = coverage(fn)</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring">    If you are using Python 2.4, you should be able to use the decorator</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring">    syntax:</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"><tt class="py-docstring">        @coverage</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line"><tt class="py-docstring">        def fn(...):</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line"><tt class="py-docstring">            ...</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">    <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt id="link-5" class="py-name" targets="Class profilehooks.TraceFuncCoverage=profilehooks.TraceFuncCoverage-class.html"><a title="profilehooks.TraceFuncCoverage" class="py-name" href="#" onclick="return doclink('link-5', 'TraceFuncCoverage', 'link-5');">TraceFuncCoverage</a></tt><tt class="py-op">(</tt><tt class="py-name">fn</tt><tt class="py-op">)</tt> <tt class="py-comment"># or HotShotFuncCoverage</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">    <tt class="py-comment"># We cannot return fp or fp.__call__ directly as that would break method</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment"># definitions, instead we need to return a plain function.</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-keyword">def</tt> <tt class="py-def-name">new_fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">fp</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
</div><a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line">    <tt class="py-name">new_fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">new_fn</tt> </tt>
</div><a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line"> </tt>
<a name="coverage_with_hotshot"></a><div id="coverage_with_hotshot-def"><a name="L198"></a><tt class="py-lineno">198</tt> <a class="py-toggle" href="#" id="coverage_with_hotshot-toggle" onclick="return toggle('coverage_with_hotshot');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks-module.html#coverage_with_hotshot">coverage_with_hotshot</a><tt class="py-op">(</tt><tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="coverage_with_hotshot-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="coverage_with_hotshot-expanded"><a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line">    <tt class="py-docstring">"""Mark `fn` for line coverage analysis.</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">    Uses the 'hotshot' module for fast coverage analysis.</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">    BUG: Produces inaccurate results.</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line"><tt class="py-docstring">    See the docstring of `coverage` for usage examples.</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">    <tt class="py-name">fp</tt> <tt class="py-op">=</tt> <tt id="link-6" class="py-name" targets="Class profilehooks.HotShotFuncCoverage=profilehooks.HotShotFuncCoverage-class.html"><a title="profilehooks.HotShotFuncCoverage" class="py-name" href="#" onclick="return doclink('link-6', 'HotShotFuncCoverage', 'link-6');">HotShotFuncCoverage</a></tt><tt class="py-op">(</tt><tt class="py-name">fn</tt><tt class="py-op">)</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line">    <tt class="py-comment"># We cannot return fp or fp.__call__ directly as that would break method</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-comment"># definitions, instead we need to return a plain function.</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt class="py-keyword">def</tt> <tt class="py-def-name">new_fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">fp</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
</div><a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line">    <tt class="py-name">new_fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">new_fn</tt> </tt>
</div><a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line"> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line"> </tt>
<a name="FuncProfile"></a><div id="FuncProfile-def"><a name="L216"></a><tt class="py-lineno">216</tt> <a class="py-toggle" href="#" id="FuncProfile-toggle" onclick="return toggle('FuncProfile');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="profilehooks.FuncProfile-class.html">FuncProfile</a><tt class="py-op">:</tt> </tt>
</div><div id="FuncProfile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="FuncProfile-expanded"><a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line">    <tt class="py-docstring">"""Profiler for a function (uses profile)."""</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line">    <tt class="py-comment"># This flag is shared between all instances</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt id="link-7" class="py-name" targets="Variable profilehooks.FuncProfile.in_profiler=profilehooks.FuncProfile-class.html#in_profiler,Variable profilehooks.HotShotFuncProfile.in_profiler=profilehooks.HotShotFuncProfile-class.html#in_profiler"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-7', 'in_profiler', 'link-7');">in_profiler</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line"> </tt>
<a name="FuncProfile.__init__"></a><div id="FuncProfile.__init__-def"><a name="L222"></a><tt class="py-lineno">222</tt> <a class="py-toggle" href="#" id="FuncProfile.__init__-toggle" onclick="return toggle('FuncProfile.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncProfile-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-param">skip</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">immediate</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncProfile.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncProfile.__init__-expanded"><a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line">        <tt class="py-docstring">"""Creates a profiler for a function.</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring">        Every profiler has its own log file (the name of which is derived from</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line"><tt class="py-docstring">        the function name).</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-docstring">        HotShotFuncProfile registers an atexit handler that prints profiling</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line"><tt class="py-docstring">        information to sys.stderr when the program terminates.</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line"><tt class="py-docstring">        The log file is not removed and remains there to clutter the current</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line"><tt class="py-docstring">        working directory.</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">filename</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">immediate</tt> <tt class="py-op">=</tt> <tt class="py-name">immediate</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt> <tt class="py-op">=</tt> <tt class="py-name">pstats</tt><tt class="py-op">.</tt><tt class="py-name">Stats</tt><tt class="py-op">(</tt><tt class="py-name">Profile</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skip</tt> <tt class="py-op">=</tt> <tt class="py-name">skip</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line">        <tt id="link-8" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-8', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">.</tt><tt class="py-name">register</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-9', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line"> </tt>
<a name="FuncProfile.__call__"></a><div id="FuncProfile.__call__-def"><a name="L243"></a><tt class="py-lineno">243</tt> <a class="py-toggle" href="#" id="FuncProfile.__call__-toggle" onclick="return toggle('FuncProfile.__call__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncProfile-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncProfile.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncProfile.__call__-expanded"><a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line">        <tt class="py-docstring">"""Profile a singe call to the function."""</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skip</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skip</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-10" class="py-name"><a title="profilehooks.FuncProfile" class="py-name" href="#" onclick="return doclink('link-10', 'FuncProfile', 'link-4');">FuncProfile</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-11', 'in_profiler', 'link-7');">in_profiler</a></tt><tt class="py-op">:</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line">            <tt class="py-comment"># handle recursive calls</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"><tt class="py-comment"></tt>            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line">        <tt class="py-comment"># You cannot reuse the same profiler for many calls and accumulate</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-comment"># stats that way.  :-/</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-name">profiler</tt> <tt class="py-op">=</tt> <tt class="py-name">Profile</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">            <tt id="link-12" class="py-name"><a title="profilehooks.FuncProfile" class="py-name" href="#" onclick="return doclink('link-12', 'FuncProfile', 'link-4');">FuncProfile</a></tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-13', 'in_profiler', 'link-7');">in_profiler</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">profiler</tt><tt class="py-op">.</tt><tt class="py-name">runcall</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line">        <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line">            <tt id="link-14" class="py-name"><a title="profilehooks.FuncProfile" class="py-name" href="#" onclick="return doclink('link-14', 'FuncProfile', 'link-4');">FuncProfile</a></tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-15', 'in_profiler', 'link-7');">in_profiler</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method groupmanager.GroupManager.add()=groupmanager.GroupManager-class.html#add"><a title="groupmanager.GroupManager.add" class="py-name" href="#" onclick="return doclink('link-16', 'add', 'link-16');">add</a></tt><tt class="py-op">(</tt><tt class="py-name">profiler</tt><tt class="py-op">)</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">immediate</tt><tt class="py-op">:</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method profilehooks.FuncProfile.print_stats()=profilehooks.FuncProfile-class.html#print_stats"><a title="profilehooks.FuncProfile.print_stats" class="py-name" href="#" onclick="return doclink('link-17', 'print_stats', 'link-17');">print_stats</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line">                <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Method profilehooks.FuncProfile.reset_stats()=profilehooks.FuncProfile-class.html#reset_stats"><a title="profilehooks.FuncProfile.reset_stats" class="py-name" href="#" onclick="return doclink('link-18', 'reset_stats', 'link-18');">reset_stats</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"> </tt>
<a name="FuncProfile.print_stats"></a><div id="FuncProfile.print_stats-def"><a name="L266"></a><tt class="py-lineno">266</tt> <a class="py-toggle" href="#" id="FuncProfile.print_stats-toggle" onclick="return toggle('FuncProfile.print_stats');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncProfile-class.html#print_stats">print_stats</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncProfile.print_stats-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncProfile.print_stats-expanded"><a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line">        <tt class="py-docstring">"""Print profile information to sys.stdout."""</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line">        <tt class="py-name">funcname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line">        <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_filename</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">        <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_firstlineno</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"*** PROFILER RESULTS ***"</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"%s (%s:%s)"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">funcname</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"function called %d times"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt><tt class="py-op">,</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt><tt class="py-op">:</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">"(%d calls not profiled)"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line">        <tt class="py-name">stats</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">:</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line">            <tt class="py-name">pickle</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt class="py-name">stats</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">        <tt class="py-name">stats</tt><tt class="py-op">.</tt><tt class="py-name">strip_dirs</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line">        <tt class="py-name">stats</tt><tt class="py-op">.</tt><tt class="py-name">sort_stats</tt><tt class="py-op">(</tt><tt class="py-string">'cumulative'</tt><tt class="py-op">,</tt> <tt class="py-string">'time'</tt><tt class="py-op">,</tt> <tt class="py-string">'calls'</tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">        <tt class="py-name">stats</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="profilehooks.FuncProfile.print_stats" class="py-name" href="#" onclick="return doclink('link-19', 'print_stats', 'link-17');">print_stats</a></tt><tt class="py-op">(</tt><tt class="py-number">40</tt><tt class="py-op">)</tt> </tt>
</div><a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line"> </tt>
<a name="FuncProfile.reset_stats"></a><div id="FuncProfile.reset_stats-def"><a name="L287"></a><tt class="py-lineno">287</tt> <a class="py-toggle" href="#" id="FuncProfile.reset_stats-toggle" onclick="return toggle('FuncProfile.reset_stats');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncProfile-class.html#reset_stats">reset_stats</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncProfile.reset_stats-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncProfile.reset_stats-expanded"><a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line">        <tt class="py-docstring">"""Reset accumulated profiler statistics."""</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt> <tt class="py-op">=</tt> <tt class="py-name">pstats</tt><tt class="py-op">.</tt><tt class="py-name">Stats</tt><tt class="py-op">(</tt><tt class="py-name">Profile</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
</div><a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line"> </tt>
<a name="FuncProfile.atexit"></a><div id="FuncProfile.atexit-def"><a name="L293"></a><tt class="py-lineno">293</tt> <a class="py-toggle" href="#" id="FuncProfile.atexit-toggle" onclick="return toggle('FuncProfile.atexit');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncProfile-class.html#atexit">atexit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncProfile.atexit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncProfile.atexit-expanded"><a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line">        <tt class="py-docstring">"""Stop profiling and print profile information to sys.stdout.</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-docstring">        This function is registered as an atexit hook.</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">immediate</tt><tt class="py-op">:</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="profilehooks.FuncProfile.print_stats" class="py-name" href="#" onclick="return doclink('link-20', 'print_stats', 'link-17');">print_stats</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncProfile"></a><div id="HotShotFuncProfile-def"><a name="L302"></a><tt class="py-lineno">302</tt> <a class="py-toggle" href="#" id="HotShotFuncProfile-toggle" onclick="return toggle('HotShotFuncProfile');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="profilehooks.HotShotFuncProfile-class.html">HotShotFuncProfile</a><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncProfile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="HotShotFuncProfile-expanded"><a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line">    <tt class="py-docstring">"""Profiler for a function (uses hotshot)."""</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line">    <tt class="py-comment"># This flag is shared between all instances</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt id="link-21" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-21', 'in_profiler', 'link-7');">in_profiler</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncProfile.__init__"></a><div id="HotShotFuncProfile.__init__-def"><a name="L308"></a><tt class="py-lineno">308</tt> <a class="py-toggle" href="#" id="HotShotFuncProfile.__init__-toggle" onclick="return toggle('HotShotFuncProfile.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.HotShotFuncProfile-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-param">skip</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncProfile.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HotShotFuncProfile.__init__-expanded"><a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line">        <tt class="py-docstring">"""Creates a profiler for a function.</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line"><tt class="py-docstring">        Every profiler has its own log file (the name of which is derived from</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line"><tt class="py-docstring">        the function name).</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line"><tt class="py-docstring">        HotShotFuncProfile registers an atexit handler that prints profiling</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line"><tt class="py-docstring">        information to sys.stderr when the program terminates.</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"><tt class="py-docstring">        The log file is not removed and remains there to clutter the current</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line"><tt class="py-docstring">        working directory.</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">filename</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">:</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt> <tt class="py-op">=</tt> <tt class="py-name">filename</tt> <tt class="py-op">+</tt> <tt class="py-string">".raw"</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> <tt class="py-op">+</tt> <tt class="py-string">".prof"</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">profiler</tt> <tt class="py-op">=</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">Profile</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt><tt class="py-op">)</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skip</tt> <tt class="py-op">=</tt> <tt class="py-name">skip</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line">        <tt id="link-22" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-22', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">.</tt><tt class="py-name">register</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-23', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncProfile.__call__"></a><div id="HotShotFuncProfile.__call__-def"><a name="L332"></a><tt class="py-lineno">332</tt> <a class="py-toggle" href="#" id="HotShotFuncProfile.__call__-toggle" onclick="return toggle('HotShotFuncProfile.__call__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.HotShotFuncProfile-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncProfile.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HotShotFuncProfile.__call__-expanded"><a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line">        <tt class="py-docstring">"""Profile a singe call to the function."""</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skip</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skip</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-24" class="py-name" targets="Class profilehooks.HotShotFuncProfile=profilehooks.HotShotFuncProfile-class.html"><a title="profilehooks.HotShotFuncProfile" class="py-name" href="#" onclick="return doclink('link-24', 'HotShotFuncProfile', 'link-24');">HotShotFuncProfile</a></tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-25', 'in_profiler', 'link-7');">in_profiler</a></tt><tt class="py-op">:</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line">            <tt class="py-comment"># handle recursive calls</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"><tt class="py-comment"></tt>            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line">            <tt id="link-26" class="py-name"><a title="profilehooks.HotShotFuncProfile" class="py-name" href="#" onclick="return doclink('link-26', 'HotShotFuncProfile', 'link-24');">HotShotFuncProfile</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-27', 'in_profiler', 'link-7');">in_profiler</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">profiler</tt><tt class="py-op">.</tt><tt class="py-name">runcall</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line">        <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line">            <tt id="link-28" class="py-name"><a title="profilehooks.HotShotFuncProfile" class="py-name" href="#" onclick="return doclink('link-28', 'HotShotFuncProfile', 'link-24');">HotShotFuncProfile</a></tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="profilehooks.FuncProfile.in_profiler
profilehooks.HotShotFuncProfile.in_profiler" class="py-name" href="#" onclick="return doclink('link-29', 'in_profiler', 'link-7');">in_profiler</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncProfile.atexit"></a><div id="HotShotFuncProfile.atexit-def"><a name="L348"></a><tt class="py-lineno">348</tt> <a class="py-toggle" href="#" id="HotShotFuncProfile.atexit-toggle" onclick="return toggle('HotShotFuncProfile.atexit');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.HotShotFuncProfile-class.html#atexit">atexit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncProfile.atexit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HotShotFuncProfile.atexit-expanded"><a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line">        <tt class="py-docstring">"""Stop profiling and print profile information to sys.stderr.</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"><tt class="py-docstring">        This function is registered as an atexit hook.</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">profiler</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line">        <tt class="py-name">funcname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line">        <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_filename</tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line">        <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_firstlineno</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"*** PROFILER RESULTS ***"</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"%s (%s:%s)"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">funcname</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"function called %d times"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt><tt class="py-op">,</tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt><tt class="py-op">:</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">"(%d calls not profiled)"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">skipped</tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line">        <tt class="py-name">stats</tt> <tt class="py-op">=</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">stats</tt><tt class="py-op">.</tt><tt class="py-name">load</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt><tt class="py-op">)</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line">        <tt class="py-comment"># hotshot.stats.load takes ages, and the .prof file eats megabytes, but</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-comment"># a pickled stats object is small and fast</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">:</tt> </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line">            <tt class="py-name">pickle</tt><tt class="py-op">.</tt><tt class="py-name">dump</tt><tt class="py-op">(</tt><tt class="py-name">stats</tt><tt class="py-op">,</tt> <tt class="py-name">file</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-string">'w'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line">        <tt class="py-comment"># it is best to pickle before strip_dirs</tt> </tt>
<a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line"><tt class="py-comment"></tt>        <tt class="py-name">stats</tt><tt class="py-op">.</tt><tt class="py-name">strip_dirs</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line">        <tt class="py-name">stats</tt><tt class="py-op">.</tt><tt class="py-name">sort_stats</tt><tt class="py-op">(</tt><tt class="py-string">'cumulative'</tt><tt class="py-op">,</tt> <tt class="py-string">'time'</tt><tt class="py-op">,</tt> <tt class="py-string">'calls'</tt><tt class="py-op">)</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line">        <tt class="py-name">stats</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="profilehooks.FuncProfile.print_stats" class="py-name" href="#" onclick="return doclink('link-30', 'print_stats', 'link-17');">print_stats</a></tt><tt class="py-op">(</tt><tt class="py-number">40</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncCoverage"></a><div id="HotShotFuncCoverage-def"><a name="L377"></a><tt class="py-lineno">377</tt> <a class="py-toggle" href="#" id="HotShotFuncCoverage-toggle" onclick="return toggle('HotShotFuncCoverage');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="profilehooks.HotShotFuncCoverage-class.html">HotShotFuncCoverage</a><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncCoverage-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="HotShotFuncCoverage-expanded"><a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line">    <tt class="py-docstring">"""Coverage analysis for a function (uses _hotshot).</tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line"><tt class="py-docstring">    HotShot coverage is reportedly faster than trace.py, but it appears to</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line"><tt class="py-docstring">    have problems with exceptions; also line counts in coverage reports</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line"><tt class="py-docstring">    are generally lower from line counts produced by TraceFuncCoverage.</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line"><tt class="py-docstring">    Is this my bug, or is it a problem with _hotshot?</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncCoverage.__init__"></a><div id="HotShotFuncCoverage.__init__-def"><a name="L386"></a><tt class="py-lineno">386</tt> <a class="py-toggle" href="#" id="HotShotFuncCoverage.__init__-toggle" onclick="return toggle('HotShotFuncCoverage.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.HotShotFuncCoverage-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncCoverage.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HotShotFuncCoverage.__init__-expanded"><a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line">        <tt class="py-docstring">"""Creates a profiler for a function.</tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line"><tt class="py-docstring">        Every profiler has its own log file (the name of which is derived from</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line"><tt class="py-docstring">        the function name).</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line"><tt class="py-docstring">        HotShotFuncCoverage registers an atexit handler that prints profiling</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line"><tt class="py-docstring">        information to sys.stderr when the program terminates.</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line"><tt class="py-docstring">        The log file is not removed and remains there to clutter the current</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line"><tt class="py-docstring">        working directory.</tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> <tt class="py-op">+</tt> <tt class="py-string">".cprof"</tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">profiler</tt> <tt class="py-op">=</tt> <tt class="py-name">_hotshot</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name" targets="Function profilehooks.coverage()=profilehooks-module.html#coverage"><a title="profilehooks.coverage" class="py-name" href="#" onclick="return doclink('link-31', 'coverage', 'link-31');">coverage</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt><tt class="py-op">)</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line">        <tt id="link-32" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-32', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">.</tt><tt class="py-name">register</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-33', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncCoverage.__call__"></a><div id="HotShotFuncCoverage.__call__-def"><a name="L404"></a><tt class="py-lineno">404</tt> <a class="py-toggle" href="#" id="HotShotFuncCoverage.__call__-toggle" onclick="return toggle('HotShotFuncCoverage.__call__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.HotShotFuncCoverage-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncCoverage.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HotShotFuncCoverage.__call__-expanded"><a name="L405"></a><tt class="py-lineno">405</tt>  <tt class="py-line">        <tt class="py-docstring">"""Profile a singe call to the function."""</tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">profiler</tt><tt class="py-op">.</tt><tt class="py-name">runcall</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
</div><a name="L408"></a><tt class="py-lineno">408</tt>  <tt class="py-line"> </tt>
<a name="HotShotFuncCoverage.atexit"></a><div id="HotShotFuncCoverage.atexit-def"><a name="L409"></a><tt class="py-lineno">409</tt> <a class="py-toggle" href="#" id="HotShotFuncCoverage.atexit-toggle" onclick="return toggle('HotShotFuncCoverage.atexit');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.HotShotFuncCoverage-class.html#atexit">atexit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="HotShotFuncCoverage.atexit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="HotShotFuncCoverage.atexit-expanded"><a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line">        <tt class="py-docstring">"""Stop profiling and print profile information to sys.stderr.</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line"><tt class="py-docstring">        This function is registered as an atexit hook.</tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">profiler</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt>  <tt class="py-line">        <tt class="py-name">funcname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line">        <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_filename</tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line">        <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_firstlineno</tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"*** COVERAGE RESULTS ***"</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"%s (%s:%s)"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">funcname</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"function called %d times"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt>  <tt class="py-line">        <tt class="py-name">fs</tt> <tt class="py-op">=</tt> <tt id="link-34" class="py-name" targets="Class profilehooks.FuncSource=profilehooks.FuncSource-class.html"><a title="profilehooks.FuncSource" class="py-name" href="#" onclick="return doclink('link-34', 'FuncSource', 'link-34');">FuncSource</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">)</tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line">        <tt class="py-name">reader</tt> <tt class="py-op">=</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">log</tt><tt class="py-op">.</tt><tt class="py-name">LogReader</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt><tt class="py-op">)</tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">what</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">,</tt> <tt class="py-name">funcname</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">tdelta</tt> <tt class="py-keyword">in</tt> <tt class="py-name">reader</tt><tt class="py-op">:</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt> <tt class="py-op">!=</tt> <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">:</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">what</tt> <tt class="py-op">==</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">log</tt><tt class="py-op">.</tt><tt class="py-name">LINE</tt><tt class="py-op">:</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line">                <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Method profilehooks.FuncSource.mark()=profilehooks.FuncSource-class.html#mark"><a title="profilehooks.FuncSource.mark" class="py-name" href="#" onclick="return doclink('link-35', 'mark', 'link-35');">mark</a></tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">what</tt> <tt class="py-op">==</tt> <tt class="py-name">hotshot</tt><tt class="py-op">.</tt><tt class="py-name">log</tt><tt class="py-op">.</tt><tt class="py-name">ENTER</tt><tt class="py-op">:</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line">                <tt class="py-comment"># hotshot gives us the line number of the function definition</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment"># and never gives us a LINE event for the first statement in</tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment"># a function, so if we didn't perform this mapping, the first</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-comment"># statement would be marked as never executed</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line"><tt class="py-comment"></tt>                <tt class="py-keyword">if</tt> <tt class="py-name">lineno</tt> <tt class="py-op">==</tt> <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt class="py-name">firstlineno</tt><tt class="py-op">:</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line">                    <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line">                <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="profilehooks.FuncSource.mark" class="py-name" href="#" onclick="return doclink('link-36', 'mark', 'link-35');">mark</a></tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt>  <tt class="py-line">        <tt class="py-name">reader</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-name">fs</tt> </tt>
</div></div><a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line"> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt>  <tt class="py-line"> </tt>
<a name="TraceFuncCoverage"></a><div id="TraceFuncCoverage-def"><a name="L442"></a><tt class="py-lineno">442</tt> <a class="py-toggle" href="#" id="TraceFuncCoverage-toggle" onclick="return toggle('TraceFuncCoverage');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="profilehooks.TraceFuncCoverage-class.html">TraceFuncCoverage</a><tt class="py-op">:</tt> </tt>
</div><div id="TraceFuncCoverage-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="TraceFuncCoverage-expanded"><a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line">    <tt class="py-docstring">"""Coverage analysis for a function (uses trace module).</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line"><tt class="py-docstring">    HotShot coverage analysis is reportedly faster, but it appears to have</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt>  <tt class="py-line"><tt class="py-docstring">    problems with exceptions.</tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line"> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line">    <tt class="py-comment"># Shared between all instances so that nested calls work</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt id="link-37" class="py-name" targets="Variable profilehooks.TraceFuncCoverage.tracer=profilehooks.TraceFuncCoverage-class.html#tracer"><a title="profilehooks.TraceFuncCoverage.tracer" class="py-name" href="#" onclick="return doclink('link-37', 'tracer', 'link-37');">tracer</a></tt> <tt class="py-op">=</tt> <tt class="py-name">trace</tt><tt class="py-op">.</tt><tt class="py-name">Trace</tt><tt class="py-op">(</tt><tt class="py-name">count</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">trace</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line">                         <tt class="py-name">ignoredirs</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">prefix</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">exec_prefix</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line"> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line">    <tt class="py-comment"># This flag is also shared between all instances</tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt>  <tt class="py-line"><tt class="py-comment"></tt>    <tt id="link-38" class="py-name" targets="Variable profilehooks.TraceFuncCoverage.tracing=profilehooks.TraceFuncCoverage-class.html#tracing"><a title="profilehooks.TraceFuncCoverage.tracing" class="py-name" href="#" onclick="return doclink('link-38', 'tracing', 'link-38');">tracing</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line"> </tt>
<a name="TraceFuncCoverage.__init__"></a><div id="TraceFuncCoverage.__init__-def"><a name="L456"></a><tt class="py-lineno">456</tt> <a class="py-toggle" href="#" id="TraceFuncCoverage.__init__-toggle" onclick="return toggle('TraceFuncCoverage.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.TraceFuncCoverage-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TraceFuncCoverage.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TraceFuncCoverage.__init__-expanded"><a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line">        <tt class="py-docstring">"""Creates a profiler for a function.</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt>  <tt class="py-line"><tt class="py-docstring">        Every profiler has its own log file (the name of which is derived from</tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt>  <tt class="py-line"><tt class="py-docstring">        the function name).</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line"><tt class="py-docstring">        TraceFuncCoverage registers an atexit handler that prints profiling</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt>  <tt class="py-line"><tt class="py-docstring">        information to sys.stderr when the program terminates.</tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line"><tt class="py-docstring">        The log file is not removed and remains there to clutter the current</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line"><tt class="py-docstring">        working directory.</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">logfilename</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> <tt class="py-op">+</tt> <tt class="py-string">".cprof"</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt>  <tt class="py-line">        <tt id="link-39" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-39', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">.</tt><tt class="py-name">register</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="profilehooks.FuncProfile.atexit
profilehooks.HotShotFuncCoverage.atexit
profilehooks.HotShotFuncProfile.atexit
profilehooks.TraceFuncCoverage.atexit" class="py-name" href="#" onclick="return doclink('link-40', 'atexit', 'link-0');">atexit</a></tt><tt class="py-op">)</tt> </tt>
</div><a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line"> </tt>
<a name="TraceFuncCoverage.__call__"></a><div id="TraceFuncCoverage.__call__-def"><a name="L473"></a><tt class="py-lineno">473</tt> <a class="py-toggle" href="#" id="TraceFuncCoverage.__call__-toggle" onclick="return toggle('TraceFuncCoverage.__call__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.TraceFuncCoverage-class.html#__call__">__call__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TraceFuncCoverage.__call__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TraceFuncCoverage.__call__-expanded"><a name="L474"></a><tt class="py-lineno">474</tt>  <tt class="py-line">        <tt class="py-docstring">"""Profile a singe call to the function."""</tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-41" class="py-name"><a title="profilehooks.TraceFuncCoverage" class="py-name" href="#" onclick="return doclink('link-41', 'TraceFuncCoverage', 'link-5');">TraceFuncCoverage</a></tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="profilehooks.TraceFuncCoverage.tracing" class="py-name" href="#" onclick="return doclink('link-42', 'tracing', 'link-38');">tracing</a></tt><tt class="py-op">:</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt>  <tt class="py-line">            <tt id="link-43" class="py-name"><a title="profilehooks.TraceFuncCoverage" class="py-name" href="#" onclick="return doclink('link-43', 'TraceFuncCoverage', 'link-5');">TraceFuncCoverage</a></tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="profilehooks.TraceFuncCoverage.tracing" class="py-name" href="#" onclick="return doclink('link-44', 'tracing', 'link-38');">tracing</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="profilehooks.TraceFuncCoverage.tracer" class="py-name" href="#" onclick="return doclink('link-45', 'tracer', 'link-37');">tracer</a></tt><tt class="py-op">.</tt><tt class="py-name">runfunc</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt>  <tt class="py-line">        <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt>  <tt class="py-line">            <tt id="link-46" class="py-name"><a title="profilehooks.TraceFuncCoverage" class="py-name" href="#" onclick="return doclink('link-46', 'TraceFuncCoverage', 'link-5');">TraceFuncCoverage</a></tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="profilehooks.TraceFuncCoverage.tracing" class="py-name" href="#" onclick="return doclink('link-47', 'tracing', 'link-38');">tracing</a></tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L483"></a><tt class="py-lineno">483</tt>  <tt class="py-line"> </tt>
<a name="TraceFuncCoverage.atexit"></a><div id="TraceFuncCoverage.atexit-def"><a name="L484"></a><tt class="py-lineno">484</tt> <a class="py-toggle" href="#" id="TraceFuncCoverage.atexit-toggle" onclick="return toggle('TraceFuncCoverage.atexit');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.TraceFuncCoverage-class.html#atexit">atexit</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TraceFuncCoverage.atexit-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="TraceFuncCoverage.atexit-expanded"><a name="L485"></a><tt class="py-lineno">485</tt>  <tt class="py-line">        <tt class="py-docstring">"""Stop profiling and print profile information to sys.stderr.</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt>  <tt class="py-line"><tt class="py-docstring">        This function is registered as an atexit hook.</tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L489"></a><tt class="py-lineno">489</tt>  <tt class="py-line">        <tt class="py-name">funcname</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt>  <tt class="py-line">        <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_filename</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt>  <tt class="py-line">        <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_firstlineno</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"*** COVERAGE RESULTS ***"</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"%s (%s:%s)"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">funcname</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"function called %d times"</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">ncalls</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt>  <tt class="py-line">        <tt class="py-name">fs</tt> <tt class="py-op">=</tt> <tt id="link-48" class="py-name"><a title="profilehooks.FuncSource" class="py-name" href="#" onclick="return doclink('link-48', 'FuncSource', 'link-34');">FuncSource</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">)</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">count</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="profilehooks.TraceFuncCoverage.tracer" class="py-name" href="#" onclick="return doclink('link-49', 'tracer', 'link-37');">tracer</a></tt><tt class="py-op">.</tt><tt class="py-name">counts</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt> <tt class="py-op">!=</tt> <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">:</tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt>  <tt class="py-line">                <tt class="py-keyword">continue</tt> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt>  <tt class="py-line">            <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="profilehooks.FuncSource.mark" class="py-name" href="#" onclick="return doclink('link-50', 'mark', 'link-35');">mark</a></tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">,</tt> <tt class="py-name">count</tt><tt class="py-op">)</tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-name">fs</tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt>  <tt class="py-line">        <tt class="py-name">never_executed</tt> <tt class="py-op">=</tt> <tt class="py-name">fs</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name" targets="Method profilehooks.FuncSource.count_never_executed()=profilehooks.FuncSource-class.html#count_never_executed"><a title="profilehooks.FuncSource.count_never_executed" class="py-name" href="#" onclick="return doclink('link-51', 'count_never_executed', 'link-51');">count_never_executed</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">never_executed</tt><tt class="py-op">:</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-string">"%d lines were not executed."</tt> <tt class="py-op">%</tt> <tt class="py-name">never_executed</tt> </tt>
</div></div><a name="L506"></a><tt class="py-lineno">506</tt>  <tt class="py-line"> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt>  <tt class="py-line"> </tt>
<a name="FuncSource"></a><div id="FuncSource-def"><a name="L508"></a><tt class="py-lineno">508</tt> <a class="py-toggle" href="#" id="FuncSource-toggle" onclick="return toggle('FuncSource');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="profilehooks.FuncSource-class.html">FuncSource</a><tt class="py-op">:</tt> </tt>
</div><div id="FuncSource-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="FuncSource-expanded"><a name="L509"></a><tt class="py-lineno">509</tt>  <tt class="py-line">    <tt class="py-docstring">"""Source code annotator for a function."""</tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt>  <tt class="py-line"> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt>  <tt class="py-line">    <tt id="link-52" class="py-name" targets="Variable profilehooks.FuncSource.blank_rx=profilehooks.FuncSource-class.html#blank_rx"><a title="profilehooks.FuncSource.blank_rx" class="py-name" href="#" onclick="return doclink('link-52', 'blank_rx', 'link-52');">blank_rx</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">r"^\s*finally:\s*(#.*)?$"</tt><tt class="py-op">)</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt>  <tt class="py-line"> </tt>
<a name="FuncSource.__init__"></a><div id="FuncSource.__init__-def"><a name="L513"></a><tt class="py-lineno">513</tt> <a class="py-toggle" href="#" id="FuncSource.__init__-toggle" onclick="return toggle('FuncSource.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncSource-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncSource.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncSource.__init__-expanded"><a name="L514"></a><tt class="py-lineno">514</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">getsourcefile</tt><tt class="py-op">(</tt><tt class="py-name">fn</tt><tt class="py-op">)</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">source</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstlineno</tt> <tt class="py-op">=</tt> <tt class="py-name">inspect</tt><tt class="py-op">.</tt><tt class="py-name">getsourcelines</tt><tt class="py-op">(</tt><tt class="py-name">fn</tt><tt class="py-op">)</tt> </tt>
<a name="L517"></a><tt class="py-lineno">517</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sourcelines</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstlineno</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name" targets="Method profilehooks.FuncSource.find_source_lines()=profilehooks.FuncSource-class.html#find_source_lines"><a title="profilehooks.FuncSource.find_source_lines" class="py-name" href="#" onclick="return doclink('link-53', 'find_source_lines', 'link-53');">find_source_lines</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L520"></a><tt class="py-lineno">520</tt>  <tt class="py-line"> </tt>
<a name="FuncSource.find_source_lines"></a><div id="FuncSource.find_source_lines-def"><a name="L521"></a><tt class="py-lineno">521</tt> <a class="py-toggle" href="#" id="FuncSource.find_source_lines-toggle" onclick="return toggle('FuncSource.find_source_lines');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncSource-class.html#find_source_lines">find_source_lines</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncSource.find_source_lines-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncSource.find_source_lines-expanded"><a name="L522"></a><tt class="py-lineno">522</tt>  <tt class="py-line">        <tt class="py-docstring">"""Mark all executable source lines in fn as executed 0 times."""</tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt>  <tt class="py-line">        <tt class="py-name">strs</tt> <tt class="py-op">=</tt> <tt class="py-name">trace</tt><tt class="py-op">.</tt><tt class="py-name">find_strings</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt>  <tt class="py-line">        <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">trace</tt><tt class="py-op">.</tt><tt class="py-name">find_lines_from_code</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">,</tt> <tt class="py-name">strs</tt><tt class="py-op">)</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">maxint</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">lineno</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">:</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt> <tt class="py-op">=</tt> <tt id="link-54" class="py-name" targets="Variable widgets.VerticalProgressBar.min=widgets.VerticalProgressBar-class.html#min"><a title="widgets.VerticalProgressBar.min" class="py-name" href="#" onclick="return doclink('link-54', 'min', 'link-54');">min</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sourcelines</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt> <tt class="py-op">==</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">maxint</tt><tt class="py-op">:</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstcodelineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstlineno</tt> </tt>
</div><a name="L531"></a><tt class="py-lineno">531</tt>  <tt class="py-line"> </tt>
<a name="FuncSource.mark"></a><div id="FuncSource.mark-def"><a name="L532"></a><tt class="py-lineno">532</tt> <a class="py-toggle" href="#" id="FuncSource.mark-toggle" onclick="return toggle('FuncSource.mark');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncSource-class.html#mark">mark</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">lineno</tt><tt class="py-op">,</tt> <tt class="py-param">count</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncSource.mark-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncSource.mark-expanded"><a name="L533"></a><tt class="py-lineno">533</tt>  <tt class="py-line">        <tt class="py-docstring">"""Mark a given source line as executed count times.</tt> </tt>
<a name="L534"></a><tt class="py-lineno">534</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L535"></a><tt class="py-lineno">535</tt>  <tt class="py-line"><tt class="py-docstring">        Multiple calls to mark for the same lineno add up.</tt> </tt>
<a name="L536"></a><tt class="py-lineno">536</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sourcelines</tt><tt class="py-op">[</tt><tt class="py-name">lineno</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sourcelines</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name" targets="Method dbmanager.DBManager.get()=dbmanager.DBManager-class.html#get,Method gfxmanager.GfxManager.get()=gfxmanager.GfxManager-class.html#get,Method groupmanager.GroupManager.get()=groupmanager.GroupManager-class.html#get,Method stagemanager.StageManager.get()=stagemanager.StageManager-class.html#get"><a title="dbmanager.DBManager.get
gfxmanager.GfxManager.get
groupmanager.GroupManager.get
stagemanager.StageManager.get" class="py-name" href="#" onclick="return doclink('link-55', 'get', 'link-55');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">count</tt> </tt>
</div><a name="L538"></a><tt class="py-lineno">538</tt>  <tt class="py-line"> </tt>
<a name="FuncSource.count_never_executed"></a><div id="FuncSource.count_never_executed-def"><a name="L539"></a><tt class="py-lineno">539</tt> <a class="py-toggle" href="#" id="FuncSource.count_never_executed-toggle" onclick="return toggle('FuncSource.count_never_executed');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncSource-class.html#count_never_executed">count_never_executed</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncSource.count_never_executed-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncSource.count_never_executed-expanded"><a name="L540"></a><tt class="py-lineno">540</tt>  <tt class="py-line">        <tt class="py-docstring">"""Count statements that were never executed."""</tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt>  <tt class="py-line">        <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstlineno</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt>  <tt class="py-line">        <tt class="py-name">counter</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L543"></a><tt class="py-lineno">543</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">source</tt><tt class="py-op">:</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sourcelines</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="dbmanager.DBManager.get
gfxmanager.GfxManager.get
groupmanager.GroupManager.get
stagemanager.StageManager.get" class="py-name" href="#" onclick="return doclink('link-56', 'get', 'link-55');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L545"></a><tt class="py-lineno">545</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="profilehooks.FuncSource.blank_rx" class="py-name" href="#" onclick="return doclink('link-57', 'blank_rx', 'link-52');">blank_rx</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L546"></a><tt class="py-lineno">546</tt>  <tt class="py-line">                    <tt class="py-name">counter</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L547"></a><tt class="py-lineno">547</tt>  <tt class="py-line">            <tt class="py-name">lineno</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">counter</tt> </tt>
</div><a name="L549"></a><tt class="py-lineno">549</tt>  <tt class="py-line"> </tt>
<a name="FuncSource.__str__"></a><div id="FuncSource.__str__-def"><a name="L550"></a><tt class="py-lineno">550</tt> <a class="py-toggle" href="#" id="FuncSource.__str__-toggle" onclick="return toggle('FuncSource.__str__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks.FuncSource-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FuncSource.__str__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="FuncSource.__str__-expanded"><a name="L551"></a><tt class="py-lineno">551</tt>  <tt class="py-line">        <tt class="py-docstring">"""Return annotated source code for the function."""</tt> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt>  <tt class="py-line">        <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt>  <tt class="py-line">        <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">firstlineno</tt> </tt>
<a name="L554"></a><tt class="py-lineno">554</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">source</tt><tt class="py-op">:</tt> </tt>
<a name="L555"></a><tt class="py-lineno">555</tt>  <tt class="py-line">            <tt class="py-name">counter</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sourcelines</tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="dbmanager.DBManager.get
gfxmanager.GfxManager.get
groupmanager.GroupManager.get
stagemanager.StageManager.get" class="py-name" href="#" onclick="return doclink('link-58', 'get', 'link-55');">get</a></tt><tt class="py-op">(</tt><tt class="py-name">lineno</tt><tt class="py-op">)</tt> </tt>
<a name="L556"></a><tt class="py-lineno">556</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">counter</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt>  <tt class="py-line">                <tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt> <tt class="py-op">*</tt> <tt class="py-number">7</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt>  <tt class="py-line">            <tt class="py-keyword">elif</tt> <tt class="py-name">counter</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="profilehooks.FuncSource.blank_rx" class="py-name" href="#" onclick="return doclink('link-59', 'blank_rx', 'link-52');">blank_rx</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt>  <tt class="py-line">                    <tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">' '</tt> <tt class="py-op">*</tt> <tt class="py-number">7</tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt>  <tt class="py-line">                <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt>  <tt class="py-line">                    <tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">'&gt;'</tt> <tt class="py-op">*</tt> <tt class="py-number">6</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt>  <tt class="py-line">                <tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">'%5d: '</tt> <tt class="py-op">%</tt> <tt class="py-name">counter</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt>  <tt class="py-line">            <tt class="py-name">lines</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">prefix</tt> <tt class="py-op">+</tt> <tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L566"></a><tt class="py-lineno">566</tt>  <tt class="py-line">            <tt class="py-name">lineno</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L567"></a><tt class="py-lineno">567</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-string">''</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">lines</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L568"></a><tt class="py-lineno">568</tt>  <tt class="py-line"> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt>  <tt class="py-line"> </tt>
<a name="timecall"></a><div id="timecall-def"><a name="L570"></a><tt class="py-lineno">570</tt> <a class="py-toggle" href="#" id="timecall-toggle" onclick="return toggle('timecall');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="profilehooks-module.html#timecall">timecall</a><tt class="py-op">(</tt><tt class="py-param">fn</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="timecall-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="timecall-expanded"><a name="L571"></a><tt class="py-lineno">571</tt>  <tt class="py-line">    <tt class="py-docstring">"""Wrap `fn` and print its execution time.</tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L573"></a><tt class="py-lineno">573</tt>  <tt class="py-line"><tt class="py-docstring">    Example:</tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L575"></a><tt class="py-lineno">575</tt>  <tt class="py-line"><tt class="py-docstring">        @timecall</tt> </tt>
<a name="L576"></a><tt class="py-lineno">576</tt>  <tt class="py-line"><tt class="py-docstring">        def somefunc(x, y):</tt> </tt>
<a name="L577"></a><tt class="py-lineno">577</tt>  <tt class="py-line"><tt class="py-docstring">            time.sleep(x * y)</tt> </tt>
<a name="L578"></a><tt class="py-lineno">578</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt>  <tt class="py-line"><tt class="py-docstring">        somefunc(2, 3)</tt> </tt>
<a name="L580"></a><tt class="py-lineno">580</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L581"></a><tt class="py-lineno">581</tt>  <tt class="py-line"><tt class="py-docstring">    will print</tt> </tt>
<a name="L582"></a><tt class="py-lineno">582</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L583"></a><tt class="py-lineno">583</tt>  <tt class="py-line"><tt class="py-docstring">        somefunc: 6.0 seconds</tt> </tt>
<a name="L584"></a><tt class="py-lineno">584</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L585"></a><tt class="py-lineno">585</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L586"></a><tt class="py-lineno">586</tt>  <tt class="py-line">    <tt class="py-keyword">def</tt> <tt class="py-def-name">new_fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt>  <tt class="py-line">            <tt class="py-name">start</tt> <tt class="py-op">=</tt> <tt id="link-60" class="py-name"><a title="spaceship.Projectile.time" class="py-name" href="#" onclick="return doclink('link-60', 'time', 'link-2');">time</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="spaceship.Projectile.time" class="py-name" href="#" onclick="return doclink('link-61', 'time', 'link-2');">time</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kw</tt><tt class="py-op">)</tt> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt>  <tt class="py-line">        <tt class="py-keyword">finally</tt><tt class="py-op">:</tt> </tt>
<a name="L591"></a><tt class="py-lineno">591</tt>  <tt class="py-line">            <tt class="py-name">duration</tt> <tt class="py-op">=</tt> <tt id="link-62" class="py-name"><a title="spaceship.Projectile.time" class="py-name" href="#" onclick="return doclink('link-62', 'time', 'link-2');">time</a></tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="spaceship.Projectile.time" class="py-name" href="#" onclick="return doclink('link-63', 'time', 'link-2');">time</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-name">start</tt> </tt>
<a name="L592"></a><tt class="py-lineno">592</tt>  <tt class="py-line">            <tt class="py-name">funcname</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt>  <tt class="py-line">            <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_filename</tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt>  <tt class="py-line">            <tt class="py-name">lineno</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">func_code</tt><tt class="py-op">.</tt><tt class="py-name">co_firstlineno</tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt>  <tt class="py-line">            <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">,</tt> <tt class="py-string">"\n  %s (%s:%s):\n    %.3f seconds\n"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt>  <tt class="py-line">                                        <tt class="py-name">funcname</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">lineno</tt><tt class="py-op">,</tt> <tt class="py-name">duration</tt><tt class="py-op">)</tt> </tt>
</div><a name="L597"></a><tt class="py-lineno">597</tt>  <tt class="py-line">    <tt class="py-name">new_fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt><tt class="py-op">.</tt><tt class="py-name">__doc__</tt> </tt>
<a name="L598"></a><tt class="py-lineno">598</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">new_fn</tt> </tt>
</div><a name="L599"></a><tt class="py-lineno">599</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Thu Jul 31 16:56:55 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
